home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Games Collection 1 / software vault.zip / software vault / CDR06 / LINKS40.ZIP / GOLF.DOC < prev    next >
Text File  |  1993-08-31  |  15KB  |  361 lines
  1. ╔═════════════════════════════════════════════════════════════════════════════╗
  2. ║                                                                             ║
  3. ║                 Corporate Headquarters BBS (815) 886-3233                   ║
  4. ║                                            (815) 886-9381                   ║
  5. ║                                                                             ║
  6. ║          T H E   L I N K S   C O U N T R Y   C L U B   G O L F              ║
  7. ║                                    v4.0                                     ║
  8. ║                                                                             ║
  9. ║                              MULTI-BBS Support                              ║
  10. ║           Supporting PCBoard, Wildcat!, Gap, QBBS, RBBS, Spitfire,          ║
  11. ║                UltraBBS, Telegard, TriTel, and Remote Access                ║
  12. ║                                                                             ║
  13. ║                               Copyright 1993                                ║
  14. ║                               by Robert Neal                                ║
  15. ║                             317 Hickory Avenue                              ║
  16. ║                            Romeoville, IL  60441                            ║
  17. ║                                                                             ║
  18. ╚═════════════════════════════════════════════════════════════════════════════╝
  19.  
  20. Changes to this documentation file from the previous version are
  21. indicated by "|" in the left hand margin. This should make finding
  22. changes to the documentation much easier and faster for those upgrading
  23. from previous versions.
  24.  
  25. The Links Country Club Golf (Links) is released as SHAREWARE. You are granted
  26. a limited license to evaluate the program. Try it out, if you continue to use 
  27. it you are required to register the program.
  28.  
  29. ============================================================================
  30. To register the program print the file MAILER.TXT and complete the
  31. information requested. Or use your VISA/MASTERCARD and register online
  32. by call (815) 886-9381, type CHARGE at the main menu prompt.
  33. ============================================================================
  34.  
  35. Links is a golfing simulation game, with either 9 or 18 holes offered
  36. for play. Users golf by making their club selection, woods, irons,
  37. wedges and putter. Yardage is determined by a set standard plus a random
  38. variable to keep the game interesting.
  39.  
  40. THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS" WITHOUT
  41. CHARGE AND WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING
  42. BUT NOT LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  43. FOR A PARTICULAR PURPOSE.  IN NO EVENT SHALL ANYONE INVOLVED WITH THE
  44. CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT, SPECIAL,
  45. OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF OR BREACH OF
  46. ANY WARRANTY.
  47.  
  48.  
  49.  
  50. FEATURES OF THE LINKS COUTNRY CLUB GOLF
  51. =======================================
  52.  
  53.   -  Ansi color support.
  54.  
  55.   -  Terminates cleanly through exit code even on runtime error.
  56.  
  57.   -  Automatically creates a top score listing suitable for inclusion
  58.      as a text/bulletin file for display within your BBS. 
  59.  
  60.   -  Detects loss of carrier.
  61.  
  62.   -  Operates in local mode (either direct from BBS or from command line).
  63.  
  64.   -  Sysop function keys to return to the board, chat mode, user stats,
  65.      increase/decrease time, etc.
  66.  
  67.   -  Direct support for PCBoard, WildCat!, Gap, QBBS, RBBS, Ultra BBS,
  68.      Telegard, TriTel and Remote Access.
  69.  
  70.   -  Support for baud rates up to 115,200
  71.  
  72. |  -  Support for COM0-15. Optional command line for non-standard IRQ's.
  73.  
  74.   -  Supports PCBoard environment variables %PCBDRIVE% and %PCBDIR%
  75.  
  76.   -  Fully Multi-Node compatible.
  77.  
  78.   -  Course editor (LINKARCH) added to customize the course layout.
  79.      For REGISTERED versions only.
  80.  
  81.   -  Optional automated monthly rollover maintenance.
  82.  
  83.  -  Supports fossil based, multi-port digiboards, as used with PCBoard
  84.      /M version.
  85.  
  86. | -  ANSI representation of each hole
  87.  
  88.  
  89.  
  90. CONFIGURING THE PROGRAM
  91.  
  92. You may use GCONFIG.EXE to create and/or edit the configuration files.
  93. To use GCONFIG, type GCONFIG GOLF.CFG. This editor will allow you to
  94. enter the appropriate configuration editor within it's own full screen
  95. editor. GCONFIG will also convert registration data from version prior
  96. to v3.3 to the new method used beginning with v3.3.  Below is the layout
  97. of the GOLF.CFG file if you wish to edit it manually.
  98.  
  99.  
  100. C:\PCB\PCBOARD.SYS
  101. Corporate Headquarters
  102. Bob
  103. Neal
  104. 0
  105.  
  106. Line 1 = Full pathname of your door file. Formats supported by this
  107.           program are: PCBOARD.SYS, USERS.SYS, DOOR.SYS, USERINFO.DAT,
  108.                       CALLINFO.BBS, DORINFOx.DEF, SFDOORS.DAT and
  109.                       GTUSER.BBS, DOOR.SYS, and TRIBBS.SYS. When using
  110.                       USERINFO.DAT, DOOR.SYS  must be in the same
  111.                       directory as USERINFO.DAT.
  112. Line 2 = BBS name
  113. Line 3 = Sysop First Name
  114. Line 4 = Sysop Last Name
  115. Line 5 = Registration number. Leave as 0 if unregistered.
  116.  
  117.  
  118. Note: This door supports the PCBoard environment variables %PCBDRIVE%
  119. and %PCBDIR%. Non-PCBoard systems may also use these variables by
  120. including the following either in your BBS batch or AUTOEXEC.BAT file:
  121.  
  122.     SET PCBDRIVE=C:            <- Drive letter of your BBS files
  123.     SET PCBDIR=\BBS            <- Path of your BBS files
  124.  
  125. Then, in your GOLF.CFG file, on the first line you may put:
  126.  
  127.    %PCBDRIVE%%PCBDIR%\PCBOARD.SYS, %PCBDRIVE%%PCBDIR%\DOOR.SYS, etc.
  128.  
  129. This allows you to use just one .CFG file for multi-node operation.
  130.  
  131.  
  132.  
  133. EXECUTING PROGRAM
  134. =================
  135.  
  136. To execute the program, enter the filename followed by the config file
  137. name (ie GOLF GOLF.CFG). If you are running the program from the command
  138. line, you may optionally enter GOLF.EXE LOCAL. The only problem with this is
  139. the default user name sysop is used instead of the username on your board.
  140. This is good for testing the game before putting it on your system, but
  141. you should once play begins execute the program locally from your BBS or
  142. consistantly run the game from the command line when you play.
  143.  
  144. This documentation will not go into the details of how you set-up a door
  145. program on your BBS. It is assumed that you have a working knowledge of
  146. how to complete this task. As each BBS is different, trying to explain
  147. the installation procedure for every BBS is not possible.
  148.  
  149. You may also specify a non-standard IRQ. Put the IRQ number after the
  150. .CFG on the command line. For example: GOLF GOLF.CFG /5. This example tells
  151. the program to use IRQ 5 instead of the standard IRQ.
  152.  
  153. You may also use the procedure above and create a variable IRQ so that
  154. you can pass the IRQ setting as: GOLF GOLF.CFG /%IRQ%.
  155.  
  156. Some users may have had conflicts when using non-standard IRQ's on
  157. Novell/Netware systems. Novell seems to use the "/" character for
  158. parameter passing. You may not optionally use the "*" character instead
  159. of the "/", for example GOLF GOLF.CFG *%IRQ% is valid. Both "*" and "/"
  160. will work.
  161.  
  162. FOSSIL DRIVER
  163. =============
  164.  
  165. Links Golf now includes support for FOSSIL drivers. This means that the
  166. program will now work with Digiboard (for Wildcat IM and PCBoard/M
  167. versions) and other fossil based multi-port boards. To activate the
  168. Fossil driver support just include /FD on the command line in your door
  169. batch file.
  170.  
  171.         For example: GOLF GOLF.CFG /FD
  172.  
  173. If no Fossil driver is available, Links Golf will display a message
  174. indicating such and exit cleanly.
  175.  
  176.  
  177.  
  178. FILES USED
  179. ===========
  180.  
  181. GOLF.EXE  - The program itself
  182. GOLF.DOC  - Documentation for the sysop to run The Links
  183. GOLF.CFG  - Configuration file
  184. GOLF.FIL  - Best scores file (top 5)
  185. GOLF.CRS  - Data file of the course. New to version 2.0 is the option to
  186.             alter the course layout by using the program LINKARCH. 
  187.             NON-REGISTERED users may NOT alter the course. The file
  188.             LINKARCH has been included for you to see how easy it is to
  189.             modify the course to your own personal layout. If you are
  190.             using a NON-REGISTERED version DO NOT alter the course, either
  191.             with a text editor or the LINKARCH program. Doing so will 
  192.             result in the game failing to load.
  193. GOLF.LOG  - This file is created when the program is run. This file will
  194.             contain a synopsis of activity in the door, who played,
  195.             number of holes played and even if they got a whole in one.
  196. |HOLExx.ANS- ANSI graphic representation of each hole. Graphics included
  197. |            with this program are for the default course. If you make
  198. |            any modifications to the course with LINKARCH, you will need
  199. |            to modify the respective HOLExx.ANS file using your favorite
  200. |            ANSI editor.
  201. |BALL.ANS  - ANSI image of golf ball.
  202. |OPEN.ANS  - ANSI image displayed at start up of program.
  203.  
  204.  
  205. REINITIALIZING THE SCOREBOARD
  206. =============================
  207.  
  208. Every so often you may want to reset the scoreboard (especially when you
  209. have the scoreboard filled with LOW scores that would be difficult or
  210. impossible to better). To reset the scoreboard enter GOLF INIT and the
  211. game will automatically reinitialize the scoreboard. You may also copy 
  212. over the original unmodified scoreboard included in this archive to 
  213. esentially reset the game.
  214.  
  215.  
  216. MONTHLY ROLLOVER MAINTENANCE
  217. ============================
  218.  
  219. You may optionally have Links Golf automatically rollover the scoreboard
  220. on a monthly basis by entering GOLF MAINTxx (where xx is the day of the
  221. month you want to rollover the scoreboard). For example, to reset your
  222. scoreboard on the first of each month, enter GOLF MAINT1. To reset on
  223. the 15th, enter GOLF MAINT15. This command should be run as part of your
  224. BBS nightly event processing. If maintenance is not required, the
  225. program will exit cleanly. If maintenance is required, the program
  226. will automatically reset the scoreboard information.
  227.  
  228.                 
  229.  
  230.  
  231. THE GAME ITSELF
  232. ===============
  233.  
  234. The game starts by displaying The Links opening screen (please do not
  235. modify this or any other part of the game), and will ask the user if he 
  236. wants to use ANSI colors. While the door info file passes the variable for
  237. if a user has ANSI on or off, this gives those players a chance who may have
  238. ANSI off for normal BBS useage to use ANSI colors while in the door.
  239.  
  240. From here he is asked if he wants to play 9 or 18 holes. If he selects 9
  241. holes he is then asked if he wishes to play the front 9 or back 9. He is
  242. then asked if he wishes to read the instructions on how to play The Links.
  243.  
  244. When prompted for club selection entering QUIT (or 'Q') will terminate
  245. play. Entering HELP (or 'H') will display a listing of available clubs
  246. and approximate distances.
  247.  
  248. |An ANSI representation of each hole is included with this program. If
  249. |the user has ANSI capabilities, the graphic image will be displayed. If
  250. |the user does not have ANSI capabilities, the program will not display
  251. |the image.
  252.  
  253. After the user has played all 9 or 18 holes his ranking is shown if he
  254. beats one of the top 5 scores. The best score file is then updated and
  255. the program asks the user if he wishes to play again or not.
  256.  
  257. SYSOP KEYS ACTIVE
  258.  
  259. F3    -  Toggles the printer On/Off. Value is passed to PCBoard and/or
  260.          written to DOOR.SYS and USERS.SYS
  261. F4    -  Toggles the Page Bell on/off. Value is passed to PCBoard
  262.          and/or written to DOOR.SYS and USERS.SYS
  263. F5    -  DOS Shell. Allows SysOp to exit to DOS from inside a DOOR.
  264. F7    -  Toggles the Caller Alarm On/Off. Value is passed to PCBoard
  265.          and/or written to DOOR.SYS and USERS.SYS
  266. F8    -  Returns the caller involuntarily to the BBS.
  267. F9    -  Toggles the local display On/Off. Value is passed to PCBoard
  268.          and/or written to DOOR.SYS and USERS.SYS
  269. F10   -  Activates SysOp CHAT mode within the DOOR.
  270. ESC   -  Deactivates CHAT mode.  DOOR is resumed.
  271. UP    -  Give the caller extra time while in the DOOR.  
  272. DN    -  Subtract time from the caller while in the DOOR. 
  273. HOME  -  HELP key for Status Line options.
  274. ALT-N -  SysOp next on toggle. Value passed to PCBoard. (PCBoard only)
  275. ALT-X -  PCBoard will exit after current caller logs off. Value is
  276.          passed to PCBoard. Not available on non-PCBoard systems.
  277.  
  278.  
  279.  
  280.  
  281.  
  282. THE LINKS COURSE EDITOR (LINKARCH.EXE)
  283. ======================================
  284.  
  285. The file GOLF.CRS contains the information concerning the course layout
  286. and MUST be edited using LINKARCH. Attempts to edit the program with a
  287. text editor will result in the game failing to execute. 
  288.  
  289. The course editor should only be used by REGISTERED users of The Links
  290. Country Club Golf. NON-REGISTERED versions will fail to execute if the
  291. orignal GOLF.CRS file is edited in anyway.
  292.  
  293. The LINKARCH file is contained in this archived file so that previously
  294. registered users have the file available without needing to request it 
  295. and also so that NON-REGISTERED users can see how easy it is to edit
  296. the course, though any changes made will not be saved.
  297.  
  298. When using the course editor you should be certain to keep the par
  299. for the front and back nine the same. As a rule of thumb, distances
  300. less than 250 yards should be a par 3, 250-375 a par 4 and anything over
  301. 375 yards should be set as par 5. 
  302.  
  303.  
  304.  
  305. CONTACT ME FOR SUPPORT
  306. ======================
  307.  
  308. If you encounter any problem you may contact me at Corporate Headquarters
  309. BBS (815) 886-3233 or (815) 886-9381 (v.32bis 1200-14400).
  310.  
  311. This program has been run extensively on my system and through the years
  312. on the systems of many who have registered (and probably more who
  313. haven't registered) this program. I feel confident that the program will
  314. perform as planned. If you do encounter any bugs (or features as some
  315. might call them), please inform me of the problem so that future
  316. releases can be corrected.
  317.  
  318. In addition to my BBS, I also hang around the SYSOPS, DOORS and BBS
  319. SOFTWARE message conferences on the RIME network. You can send me
  320. messages via this network.
  321.  
  322. If you have any suggestions for improvements for this program, please feel
  323. free to let me know. This game has included suggestions from users of my
  324. BBS as well as the beta testing BBS. 
  325.  
  326.                               TROUBLESHOOTING
  327.                            =====================
  328.  
  329. If you are running this on a 486 system and encounter problems, you may
  330. need to put 'SET NO87=ON' in your AUTOEXEC.BAT file or you may place
  331. this in the GOLF batch file just before the line GOLF GOLF.CFG, for
  332. example:
  333.  
  334.      @ECHO OFF
  335.      C:
  336.      CD \GOLF
  337.      SET NO87=ON
  338.      GOLF GOLF.CFG
  339.      %PCBDRIVE%
  340.      CD %PCBDIR%
  341.      IF (%INPCB%)==(Y) EXIT
  342.      BOARD
  343.  
  344.  
  345. If you are running on a 486 system with co-processor under DesqView, you
  346. may alternately set Math Coprocessor in each window to YES.
  347.  
  348.  
  349.  
  350.  
  351. DISTRIBUTION SITE:
  352.  
  353.    As always you can find the latest version of Links available for
  354.    downloading from Corporate Headquarters BBS.
  355.  
  356.    Corporate Headquarters BBS  Node #1 (815)886-3233 (1200-14400 v.32bis)
  357.                                Node #2 (815)886-9381 (1200-14400 v.32bis)
  358.  
  359. You may register online using your Visa or MasterCard by calling the
  360. support BBS and typing CHARGE at the main menu prompt.
  361.